Description

Resurrects documentation from closed PR #1571. Adds AGENTS.md to repository root with comprehensive build and test instructions for developers and CI/CD agents.

AGENTS.md Contents

General Guidelines

• Code review: only make high confidence suggestions when reviewing code changes
• Always use the latest stable version of C#
• Never add or change global.json unless explicitly asked to
• Never change NuGet.config files unless explicitly asked to
• Null handling: declare variables non-nullable, check for null at public API entry points; for internal code, trust C# null annotations
• Testing: do not emit "Act", "Arrange" or "Assert" comments in test code

Prerequisites and Build

• Prerequisites: .NET SDK 10.0 and .NET Runtimes for 8.0 and 9.0
• Quick start: simple dotnet build and dotnet test commands for quick iteration; full solution build in Release mode for final validation
• Testing requirements: code coverage should be maintained or increased
• Points to .github/workflows/Steeltoe.All.yml for detailed test procedures including environment-specific filters and test categories
• Integration tests require Docker containers (Config Server, Eureka Server) to be running
• Platform-specific test skipping uses attributes like [FactSkippedOnPlatform] and [TheorySkippedOnPlatform] instead of trait categories
• Code style validation instructions (using cleanupcode.ps1 and .github/workflows/verify-code-style.yml)

Troubleshooting

• Troubleshooting guide including build warnings during refactoring (/p:TreatWarningsAsErrors=false)
• Important note that all warnings should be addressed before committing final changes
• Note clarifying that Steeltoe Azure Container Registry allows anonymous pulls (no authentication required)

Based on .github/workflows/Steeltoe.All.yml workflow commands.

Code Changes

• ManagementOptionsTest.cs - Renamed DefaultJsonSerializerOptions to ExpectedJsonSerializerOptions to better reflect that these are the expected serializer settings that tests assert against, not the default system settings

The JavaScriptEncoder remains configured with UnsafeRelaxedJsonEscaping in ConfigureManagementOptions.cs as originally designed, which is required for the route mappings actuator to make generic method signatures human-readable (e.g., backticks in generic type names).

Branch Updates

Merged latest changes from main branch, including updates to test attributes that replace [Trait("Category", "SkipOnMacOS")] with [FactSkippedOnPlatform(nameof(OSPlatform.OSX))].

Fixes #1571

Quality checklist

• Your code complies with our Coding Style.
• You've updated unit and/or integration tests for your change, where applicable.
• You've updated documentation for your change, where applicable.
  If your change affects other repositories, such as Documentation, Samples and/or MainSite, add linked PRs here.
• There's an open issue for the PR that you are making. If you'd like to propose a new feature or change, please open an issue to discuss the change or find an existing issue.
• You've added required license files and/or file headers (explaining where the code came from with proper attribution), where code is copied from StackOverflow, a blog, or OSS.

✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.